package com.acmen.easyapi.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 注解声明接口
 *
 * @Author acmen
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface RestApi {
    /**
     * 所属模块
     * @return
     */
    String module() default "";
    /**
     * 接口名
     * @return
     */
    String name() default "";
    /**
     * 排序号
     * @return
     */
    int idx() default 999;

    /**
     * 接口编号
     * @return
     */
    String no() default "";

    /**
     * 权限标识
     * @return
     */
    String permission() default "";

    /**
     * 作者或者负责人
     */
    String author() default "";
    /**
     * 接口说明,支持文件路径
     */
    String note() default "";
    /**
     * 是否完成
     * @return
     */
    boolean completed() default true;

}
